<!doctype html>
<html lang="en">
<head>
    <title>API for class plain (phpAPI: PHP Documentation Creator version 6.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link rel="stylesheet" type="text/css" href="../style.css">
    <link rel="start" href="../index.html">
</head>
    <body id="plain" onload="parent.document.title=document.title;">
    <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../plain/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../plain/package-tree.html">plain\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    <hr />
<div class="package">Namespace plain</div>
<h1>Class plain</h1>
<div id="list">
    <ul>
        <li><strong>plain</strong></li></ul></li>    </ul>
</div>
<hr />
<p class="arguments">public  class <strong>plain</strong></p>
<div class="comment" id="overview_description">Plain doclet.<br /> This doclet generates HTML output without frames.</div>
<div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Program</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">phpapi: PHP Documentation Creator</td>
                    </tr>
            <tr>
            <td class="hid left w_100">File</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">/system/plain/plain.php</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Version</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">6.0</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Author</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Victor Nabatov greenray.spb@gmail.com</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Copyright</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">(c) 2015-2016 Victor Nabatov</td>
                    </tr>
            <tr>
            <td class="hid left w_100">License</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creative Commons Attribution-ShareAlike 4.0 International</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Overview</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Frames doclet.
 This doclet generates HTML output without frames.</td>
                    </tr>
        </table>
</div>
    <h2 id="details_fields">Fields</h2>
            <div class="location">system/plain/plain.php at line 24</div>
        <pre class="arguments" id="header">public  string <strong><span class="green">$header</span></strong> = <span class="red">"Unknown"</span>;</pre>
        <div class="details">Specifies the header text to be placed at the top of each output file.<br /> Header will be placed to the right of the upper navigation bar.</div>
        <hr />
            <div class="location">system/plain/plain.php at line 27</div>
        <pre class="arguments" id="rootDoc">public  <a href="../phpapi/rootdoc.html">rootDoc</a> <strong><span class="green">$rootDoc</span></strong></pre>
        <div class="details">Reference to the root doc</div>
        <hr />
        <h2 id="details_constructor">Constructor</h2>
    <div class="location">system/plain/plain.php at line 35</div>
    <code class="arguments" id="construct">public  void <strong>construct</strong>(<a href="../phpapi/rootdoc.html">rootDoc</a> <span class="blue">&$rootDoc</span>, <a href="../formatters/htmlformatter.html">htmlFormatter</a> <span class="blue">$formatter</span>)</code>
    <div class="details">
            <span class="bold">require</span> <span class="red">'items.php'</span>;<br/><br/><span class="bold">require</span> <span class="red">'classItems.php'</span>;<br/><br/>            <p class="description">Doclet constructor.</p>
        <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac"><a href="../phpapi/rootdoc.html">rootDoc</a></td>
                            <td class="hid blue w_100">&$rootDoc</td>
                <td class="hid">Reference to the root document</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac"><a href="../formatters/htmlformatter.html">htmlFormatter</a></td>
                            <td class="hid blue w_100">$formatter</td>
                <td class="hid">Documentation formatter</td>
                    </tr>
        </table>
</div>
    </div>
    <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../plain/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../plain/package-tree.html">plain\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    </body>
</html>
